﻿<?xml version="1.0" encoding="utf-8" ?>
<helpItems xmlns="http://msh" schema="maml">
  <command:command 
    xmlns:maml="http://schemas.microsoft.com/maml/2004/10"
    xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10"
    xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10">

    <!-- Cmdlet details section-->
    
    <command:details>
      <command:name>Get-OrchardFeature</command:name>
      <maml:description>
        <maml:para>Gets features exposed through Orchard modules.</maml:para>
      </maml:description>
      <maml:copyright>
        <maml:para></maml:para>
      </maml:copyright>
      <command:verb>Get</command:verb>
      <command:noun>OrchardFeature</command:noun>
      <dev:version></dev:version>
    </command:details>

    <!-- Cmdlet description section-->
    
    <maml:description>
      <maml:para>The Get-OrchardFeature cmdlet gets features which are available in Orchard tenants.</maml:para>
    </maml:description>

    <!-- Cmdlet syntax section-->
    
    <command:syntax>

      <command:syntaxItem>
        <maml:name>Get-OrchardFeature</maml:name>
        <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false">
          <maml:name>Tenant</maml:name>
          <maml:description>
            <maml:para>Specifies the name of the Orchard tenant to get features from.</maml:para>
          </maml:description>
          <command:parameterValue required="false" variableLength="true">string</command:parameterValue>
        </command:parameter>
        <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false">
          <maml:name>Enabled</maml:name>
          <maml:description>
            <maml:para>Specifies that the command should get only features which are enabled.</maml:para>
          </maml:description>
        </command:parameter>
        <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false">
          <maml:name>Disabled</maml:name>
          <maml:description>
            <maml:para>Specifies that the command should get only features which are disabled.</maml:para>
          </maml:description>
        </command:parameter>
      </command:syntaxItem>

      <command:syntaxItem>
        <maml:name>Get-OrchardFeature</maml:name>
        <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="false" position="1">
          <maml:name>Name</maml:name>
          <maml:description>
            <maml:para>Specifies the name of the Orchard feature to get. This parameter is required.</maml:para>
          </maml:description>
          <command:parameterValue required="true" variableLength="true">string</command:parameterValue>
        </command:parameter>
        <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false">
          <maml:name>Tenant</maml:name>
          <maml:description>
            <maml:para>Specifies the name of the Orchard tenant to get features from.</maml:para>
          </maml:description>
          <command:parameterValue required="false" variableLength="true">string</command:parameterValue>
        </command:parameter>
        <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false">
          <maml:name>Enabled</maml:name>
          <maml:description>
            <maml:para>Specifies that the command should get only features which are enabled.</maml:para>
          </maml:description>
        </command:parameter>
        <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false">
          <maml:name>Disabled</maml:name>
          <maml:description>
            <maml:para>Specifies that the command should get only features which are disabled.</maml:para>
          </maml:description>
        </command:parameter>
      </command:syntaxItem>

      <command:syntaxItem>
        <maml:name>Get-OrchardFeature</maml:name>
        <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" position="1">
          <maml:name>Name</maml:name>
          <maml:description>
            <maml:para>Specifies the name of the Orchard feature to get.</maml:para>
          </maml:description>
          <command:parameterValue required="false" variableLength="true">string</command:parameterValue>
        </command:parameter>
        <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="true">
          <maml:name>TenantObject</maml:name>
          <maml:description>
            <maml:para>Specifies the object that represents the Orchard tenant to get features from. This object can be acquired by using the Get-ChildItem cmdlet on the Orchard PSDrive contents or by using the Get-Tenant cmdlet. This parameter is required.</maml:para>
          </maml:description>
          <command:parameterValue required="false" variableLength="true">string</command:parameterValue>
        </command:parameter>
        <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false">
          <maml:name>Enabled</maml:name>
          <maml:description>
            <maml:para>Specifies that the command should get only features which are enabled.</maml:para>
          </maml:description>
        </command:parameter>
        <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false">
          <maml:name>Disabled</maml:name>
          <maml:description>
            <maml:para>Specifies that the command should get only features which are disabled.</maml:para>
          </maml:description>
        </command:parameter>
      </command:syntaxItem>

      <command:syntaxItem>
        <maml:name>Get-OrchardFeature</maml:name>
        <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false">
          <maml:name>FromAllTenants</maml:name>
          <maml:description>
            <maml:para>Specifies that the command should get features from all running Orchard tenants.</maml:para>
          </maml:description>
        </command:parameter>
        <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="false" position="1">
          <maml:name>Name</maml:name>
          <maml:description>
            <maml:para>Specifies the name of the Orchard feature to get.</maml:para>
          </maml:description>
          <command:parameterValue required="false" variableLength="true">string</command:parameterValue>
        </command:parameter>
        <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false">
          <maml:name>Enabled</maml:name>
          <maml:description>
            <maml:para>Specifies that the command should get only features which are enabled.</maml:para>
          </maml:description>
        </command:parameter>
        <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false">
          <maml:name>Disabled</maml:name>
          <maml:description>
            <maml:para>Specifies that the command should get only features which are disabled.</maml:para>
          </maml:description>
        </command:parameter>
      </command:syntaxItem>
      
    </command:syntax>

    <!-- Cmdlet parameters section-->
    
    <command:parameters>
      
      <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" position="1">
        <maml:name>Name</maml:name>
        <maml:description>
          <maml:para>Specifies the name of the Orchard feature to get.</maml:para>
        </maml:description>
        <command:parameterValue required="false" variableLength="true">string</command:parameterValue>
        <dev:type>
          <maml:name>string</maml:name>
          <maml:uri/>
        </dev:type>
        <dev:defaultValue></dev:defaultValue>
      </command:parameter>
      
      <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false">
        <maml:name>Tenant</maml:name>
        <maml:description>
          <maml:para>Specifies the name of the Orchard tenant to get features from.</maml:para>
        </maml:description>
        <command:parameterValue required="false" variableLength="true">string</command:parameterValue>
        <dev:type>
          <maml:name>string</maml:name>
          <maml:uri/>
        </dev:type>
        <dev:defaultValue></dev:defaultValue>
      </command:parameter>

      <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="true">
        <maml:name>TenantObject</maml:name>
        <maml:description>
          <maml:para>Specifies the object that represents the Orchard tenant to get features from. This object can be acquired by using the Get-ChildItem cmdlet on the Orchard PSDrive contents or by using the Get-Tenant cmdlet.</maml:para>
        </maml:description>
        <command:parameterValue required="true" variableLength="false">OrchardTenant</command:parameterValue>
        <dev:type>
          <maml:name>OrchardTenant</maml:name>
          <maml:uri/>
        </dev:type>
        <dev:defaultValue></dev:defaultValue>
      </command:parameter>

      <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false">
        <maml:name>FromAllTenants</maml:name>
        <maml:description>
          <maml:para>Specifies that the command should get features from all running Orchard tenants.</maml:para>
        </maml:description>
        <dev:defaultValue></dev:defaultValue>
      </command:parameter>

      <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false">
        <maml:name>Enabled</maml:name>
        <maml:description>
          <maml:para>Specifies that the command should get only features which are enabled.</maml:para>
        </maml:description>
        <dev:defaultValue></dev:defaultValue>
      </command:parameter>

      <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false">
        <maml:name>Disabled</maml:name>
        <maml:description>
          <maml:para>Specifies that the command should get only features which are disabled.</maml:para>
        </maml:description>
        <dev:defaultValue></dev:defaultValue>
      </command:parameter>
      
    </command:parameters>

    <!-- Input - Output section-->
    
    <command:inputTypes>
      <command:inputType>
        <dev:type>
          <maml:name>Proligence.PowerShell.Tenants.Items.OrchardTenant</maml:name>
          <maml:uri/>
          <maml:description />
        </dev:type>
        <maml:description>
          <maml:para>You can pipe instances of the OrchardTenant class to Get-OrchardFeature. This object can be acquired by using the Get-ChildItem cmdlet on the Orchard PSDrive contents or by using the Get-Tenant cmdlet.</maml:para>
        </maml:description>
      </command:inputType>
    </command:inputTypes>

    <command:returnValues>
      <command:returnValue>
        <dev:type>
          <maml:name>Proligence.PowerShell.Features.Items.OrchardFeature</maml:name>
          <maml:uri></maml:uri>
          <maml:description>
            <maml:para />
          </maml:description>
        </dev:type>
      </command:returnValue>
    </command:returnValues>

    <!-- Error section-->
    
    <command:terminatingErrors />
    <command:nonTerminatingErrors />

    <!-- Notes section  -->

    <maml:alertSet>
      <maml:title></maml:title>
      <maml:alert>
        <maml:para>
          When no tenant is specified, then the command will use the tenant at the current location in the Orchard drive. If the location is not in any Orchard tenant, then the Default tenant is used.
        </maml:para>
      </maml:alert>
    </maml:alertSet>

    <!-- Example section  -->
    
    <command:examples>
      
      <command:example>
        <maml:title>
          -------------------------- EXAMPLE 1 --------------------------
        </maml:title>
        <maml:introduction>
          <maml:para>Orchard:\Tenants\MyTenant&gt; </maml:para>
        </maml:introduction>
        <dev:code>
          Get-OrchardFeature
        </dev:code>
        <dev:remarks>
          <maml:para>Description</maml:para>
          <maml:para>-----------</maml:para>
          <maml:para>This command gets all features available in the 'MyTenant' tenant. In this case the tenant from the current location in the Orchard drive is used, since no tenant name or object was specified as a parameter.</maml:para>
          <maml:para></maml:para>
          <maml:para></maml:para>
          <maml:para></maml:para>
          <maml:para></maml:para>
        </dev:remarks>
        <command:commandLines>
          <command:commandLine>
            <command:commandText></command:commandText>
          </command:commandLine>
        </command:commandLines>
      </command:example>

      <command:example>
        <maml:title>
          -------------------------- EXAMPLE 2 --------------------------
        </maml:title>
        <maml:introduction>
          <maml:para>Orchard:\&gt; </maml:para>
        </maml:introduction>
        <dev:code>
          Get-OrchardFeature -Tenant MyTenant
        </dev:code>
        <dev:remarks>
          <maml:para>Description</maml:para>
          <maml:para>-----------</maml:para>
          <maml:para>This command gets all features available in the 'MyTenant' tenant. In this case the tenant is specified explicitly using the 'Tenant' parameter.</maml:para>
          <maml:para></maml:para>
          <maml:para></maml:para>
          <maml:para></maml:para>
          <maml:para></maml:para>
        </dev:remarks>
        <command:commandLines>
          <command:commandLine>
            <command:commandText></command:commandText>
          </command:commandLine>
        </command:commandLines>
      </command:example>

      <command:example>
        <maml:title>
          -------------------------- EXAMPLE 3 --------------------------
        </maml:title>
        <maml:introduction>
          <maml:para>Orchard:\&gt; </maml:para>
        </maml:introduction>
        <dev:code>
          Get-OrchardFeature -Enabled
        </dev:code>
        <dev:remarks>
          <maml:para>Description</maml:para>
          <maml:para>-----------</maml:para>
          <maml:para>This command gets all features which are enabled in the Default tenant. The default tenant is used because the current location in the Orchard drive is not in any tenant and there was no tenant specified as a parameter.</maml:para>
          <maml:para></maml:para>
          <maml:para></maml:para>
          <maml:para></maml:para>
          <maml:para></maml:para>
        </dev:remarks>
        <command:commandLines>
          <command:commandLine>
            <command:commandText></command:commandText>
          </command:commandLine>
        </command:commandLines>
      </command:example>

      <command:example>
        <maml:title>
          -------------------------- EXAMPLE 4 --------------------------
        </maml:title>
        <maml:introduction>
          <maml:para>Orchard:\&gt;</maml:para>
        </maml:introduction>
        <dev:code>
          Get-OrchardFeature -FromAllTenants -Name Alias
        </dev:code>
        <dev:remarks>
          <maml:para>Description</maml:para>
          <maml:para>-----------</maml:para>
          <maml:para>This command gets the 'Alias' feature from all running Orchard tenants.</maml:para>
          <maml:para></maml:para>
          <maml:para></maml:para>
          <maml:para></maml:para>
          <maml:para></maml:para>
        </dev:remarks>
        <command:commandLines>
          <command:commandLine>
            <command:commandText></command:commandText>
          </command:commandLine>
        </command:commandLines>
      </command:example>
      
    </command:examples>

    <!-- Related links section  -->

    <RelatedLinks>
      <navigationLink>
        <linkText>Get-ChildItem</linkText>
        <uri/>
      </navigationLink>
      <navigationLink>
        <linkText>Enable-OrchardFeature</linkText>
        <uri/>
      </navigationLink>
      <navigationLink>
        <linkText>Disable-OrchardFeature</linkText>
        <uri/>
      </navigationLink>
    </RelatedLinks>

  </command:command>
</helpItems>